pp108 : Creating an Inbox Model

Creating an Inbox Model

This topic describes the procedure to create an inbox model for a notification message.

Every task from a business process is sent to the Inbox of the relevant user, role, team, or work list, which will eventually be picked up by the concerned users. The attributes that must be displayed as columns in the Inbox can be defined, by the Worklist manager, through the Inbox modeler.
For example, let us assume that there is a task of registering an Order, a worklist manager can choose to display the fields, such as, OrderID, Order Quantity, and Discount as columns in the Inbox, so that the users have the provision of sorting their messages based on these columns.
This task is part of creating an inbox model on the messages in the Delivery Model. Using the Inbox model tab, you can personalize and model the tasks that are sent to a user's Process Platform Inbox.

  1. Select the Enable Inbox Model check box at the bottom of the screen of the Delivery Model. An Inbox Model tab is added to the existing tabs.
  2. Click the Inbox Model tab. An Inbox modeler appears, displaying the XML structure defined for the Task in a tree structure on the model tab by default.
  3. Type name and a meaningful description for the Inbox model in the Name and Description fields.
  4. Expand the Application Data and select the attributes, that you want to display as columns in the 'My Inbox'. The selected attributes and their XPaths are displayed in the Inbox View section on the right pane, in the respective columns. The data type associated to the selected attribute is shown in the Data Type column.
  1. Note:

    • The selected attributes are displayed in the Inbox only when the task is delivered to any of the following:
      • work list
      • team
      • role
      • user
    • Furthermore, the attributes to be displayed in the 'My Inbox' can be customized through the Inbox customization interface.
    • You can modify the names of the attributes in the Column Name field, which are used as information headers in the 'My Inbox'.
    • For the Inbox columns for which the data type value is not available, the data type value is set to Read from Source. While publishing such columns, the data type defined in the Source (Schema, Free Form Controls, and so on) will be associated with them. The data type will not be available only when the content is migrated from earlier versions of Process Platform.
    • While changing the data type of the Inbox column, ensure that the selected data type is same as the source or it belongs to the supported data types shown below.
      If the selected datatype is not one of the supported conversions, you may not be able to view the data in Inbox grid of the corresponding Inbox Column.
      Supported Data Type Conversion:

      Boolean

      Integer

      Float

      Date

      String

      Boolean

      (tick)

      (tick)

      (tick)

      (error)

      (tick)

      Integer

      (error)

      (tick)

      (tick)

      (error)

      (tick)

      Float

      (error)

      (error)

      (tick)

      (error)

      (tick)

      Date

      (error)

      (error)

      (error)

      (tick)

      (tick)

      String

      (error)

      (error)

      (error)

      (error)

      (tick)

    • On opening the Inbox Model tab, if some of the Inbox columns are marked with !, it indicates that these fields are no longer available in the Source (Schema, Free Form Controls, and so on). Click to delete such columns and save the Delivery Model. Otherwise, validation of your project content will fail.
    • After synchronizing your projects or upgrading them in CWS, you must publish the projects in sequence. Do not try to publish your projects in parallel when doing it for the first time. However, subsequent publishes can be done in parallel
    • In any Process Platform instance, the number of unique inbox model columns allowed across all projects and organizations are as follows:
      • a maximum of 25 String data types
      • a maximum of 5 each of type Integer, Float, Boolean and Date.
        If the number of columns exceed the above limits, then publishing or deploying the Inbox model columns may fail and displays the following message: 'Unable to Map Inbox model columns'.